[docs][conf]: improve model configuration instructions and update .gitignore#38
[docs][conf]: improve model configuration instructions and update .gitignore#38TriangleMesh wants to merge 2 commits into
Conversation
- Update README.md and README.cn.md to clarify model configuration steps - Add clear instructions to copy template files from the correct path - Specify full file paths to avoid confusion about working directory - Add model_config and model_runtime_config files to .gitignore to prevent accidental commits of sensitive configuration data - Add template configuration files for various model providers The changes make the setup process clearer for new users by: 1. Showing the exact cp command with full paths 2. Removing ambiguous directory navigation instructions 3. Protecting sensitive config files from being committed 4. Providing template files for different model providers
|
|
|
Our templates are in this path: https://github.com/coze-dev/coze-loop/tree/main/backend/modules/llm/infra/config/model_repo_example . Have you noticed that? Additionally, is your main requirement to maintain the same user experience as Coze-Studio? |
Thanks for pointing that out! I missed it! My main goal is to prevent developers from accidentally uploading the API keys after they modifying their config files. Besides, I also noticed that in the readme of Coze Studio, https://github.com/coze-dev/coze-studio/blob/main/README.md?plain=1, they also used the same method of copying the template config file, so I’m submitting this PR to make sure everything is aligned. |
|
That's a good idea, but it involves some code changes. We will inform you of our decision after we evaluate and discuss it. |
|
We plan to develop product features for model management in August. By then, models can be configured directly on the frontend without needing to use YAML files. Therefore, we've decided not to merge this PR for the time being. |
Got it, thanks for the clarification! Closing this PR for now. Please feel free to ping me if there’s anything I can help with in the future — happy to contribute further! |
3 participants
What type of PR is this?
docs: Documentation only changes
Check the PR title.
(Optional) Translate the PR title into Chinese.
[docs][conf]: 改进模型配置说明并更新 .gitignore
(Optional) More detailed description for this PR(en: English/zh: Chinese).
en: This PR improves the model configuration setup process by clarifying the documentation and protecting sensitive configuration files, making it consistent with the model configuration approach used in Coze Studio. The changes include:
These changes make the setup process more user-friendly, reduce the likelihood of configuration errors for new users, and provide a consistent experience across the Coze ecosystem.
zh(optional): 此 PR 通过澄清文档和保护敏感配置文件来改进模型配置设置过程，使其与 Coze Studio 中使用的模型配置方法保持一致。更改包括：
这些更改使设置过程更加用户友好，减少新用户出现配置错误的可能性，并在整个 Coze 生态系统中提供一致的体验。
(Optional) Which issue(s) this PR fixes:
N/A - This is a documentation and setup improvement PR that doesn't fix a specific reported issue, but enhances the user experience for model configuration setup by aligning it with Coze Studio's approach.